fix(MessageEmbed): Skip validation of field when inside a message #3894
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DevYukine
approved these changes
Mar 4, 2020
NotSugden
suggested changes
Mar 4, 2020
SpaceEEC
requested changes
Mar 4, 2020
|
Been running this fork on my bot that originally found this issue for a while now, hasn't thrown this error so I'm pretty confident this flag is working as intended. |
iCrawl
approved these changes
Mar 6, 2020
SpaceEEC
requested changes
Mar 6, 2020
There was a problem hiding this comment.
Passing something like [{ name: 'foo', value: 'bar' }, { name: 'foo', value: 'bar' }] to addFields or spliceFields on embeds skipping validation breaks the fields property:
// Assume this embed is taken from `Message#embeds` rather than being manually instantiated.
> new MessageEmbed({}, true).addFields([{ name: 'foo', value: 'bar' }, { name: 'foo', value: 'bar' }]).fields
[
Array {
'0': { name: 'foo', value: 'bar' },
'1': { name: 'foo', value: 'bar' }
}
]Compared to:
> new MessageEmbed({}).addFields([{ name: 'foo', value: 'bar' }, { name: 'foo', value: 'bar' }]).fields
[
{ name: 'foo', value: 'bar', inline: false },
{ name: 'foo', value: 'bar', inline: false }
]The fix is to Array#flat the fields, like normalizeFields does too.
While modifying those embeds is not exactly a recommended use-case, it is a "supported" one and shouldn't break.
- dead code
discord.js does not use those methods interally and won't in the future, as Discord
does not emit any partial embed updates and doing so in the future seems unlikely.
- a breaking change (an incompatible api change)
Although it's not recommended to do, users can modify
received embeds without cloning them, e.g.:
const embed = message.embeds[0].addField('some title', '');
(replace '' with some function call; this is just an example)
This would no longer throw a synchronous error (breaking change),
but at a later point when actually sending it. (poorer to debug)
SpaceEEC
approved these changes
Mar 8, 2020
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please describe the changes this PR makes and why it should be merged:
This should fix #3892 by skipping validation on embeds when they are part of a parent message.
The library works fine with this change, but per discussion in #library-discussion, we can't actually reproduce the buggy embed to test this. One should be able to assume this will work though (assuming I've added the flag in the right places) as it is disabling the validation that was throwing the error.
Status
Semantic versioning classification: